<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="aiplatform_v1beta1.html">Vertex AI API</a> . <a href="aiplatform_v1beta1.projects.html">projects</a> . <a href="aiplatform_v1beta1.projects.locations.html">locations</a> . <a href="aiplatform_v1beta1.projects.locations.sessions.html">sessions</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new Session in a given project and location.</p>
<p class="toc_element">
  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes details of the specific Session.</p>
<p class="toc_element">
  <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details of the specific Session.</p>
<p class="toc_element">
  <code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Sessions in a given project and location.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the specific Session.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
  <pre>Creates a new Session in a given project and location.

Args:
  parent: string, Required. The resource name of the location to create the session in. Format: `projects/{project}/locations/{location}` or `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
  body: object, The request body.
    The object takes the form of:

{ # A session contains a set of actions between users and Vertex agents.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the session was created.
  &quot;displayName&quot;: &quot;A String&quot;, # Optional. The display name of the session.
  &quot;name&quot;: &quot;A String&quot;, # Required. Identifier. The resource name of the session. Format: &#x27;projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}&#x27;.
  &quot;sessionState&quot;: { # Optional. Session specific memory which stores key conversation points.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
  },
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the session was updated.
  &quot;userId&quot;: &quot;A String&quot;, # Required. Immutable. String id provided by the user
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
  <pre>Deletes details of the specific Session.

Args:
  name: string, Required. The resource name of the session. Format: `projects/{project}/locations/{location}/sessions/{session}` or `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
    &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
      },
    ],
    &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
  &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  &quot;response&quot;: { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
  },
}</pre>
</div>

<div class="method">
    <code class="details" id="get">get(name, x__xgafv=None)</code>
  <pre>Gets details of the specific Session.

Args:
  name: string, Required. The resource name of the session. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A session contains a set of actions between users and Vertex agents.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the session was created.
  &quot;displayName&quot;: &quot;A String&quot;, # Optional. The display name of the session.
  &quot;name&quot;: &quot;A String&quot;, # Required. Identifier. The resource name of the session. Format: &#x27;projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}&#x27;.
  &quot;sessionState&quot;: { # Optional. Session specific memory which stores key conversation points.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
  },
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the session was updated.
  &quot;userId&quot;: &quot;A String&quot;, # Required. Immutable. String id provided by the user
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
  <pre>Lists Sessions in a given project and location.

Args:
  parent: string, Required. The resource name of the location to list sessions from. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}` (required)
  filter: string, Optional. The standard list filter. Supported fields: * `display_name` Example: `display_name=abc`.
  orderBy: string, Optional. A comma-separated list of fields to order by, sorted in ascending order. Use &quot;desc&quot; after a field name for descending. Supported fields: * `create_time` * `update_time` Example: `create_time desc`.
  pageSize: integer, Optional. The maximum number of sessions to return. The service may return fewer than this value. If unspecified, at most 100 sessions will be returned.
  pageToken: string, Optional. The next_page_token value returned from a previous list SessionService.ListSessions call.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for SessionService.ListSessions.
  &quot;nextPageToken&quot;: &quot;A String&quot;, # A token, which can be sent as ListSessionsRequest.page_token to retrieve the next page. Absence of this field indicates there are no subsequent pages.
  &quot;sessions&quot;: [ # A list of sessions matching the request.
    { # A session contains a set of actions between users and Vertex agents.
      &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the session was created.
      &quot;displayName&quot;: &quot;A String&quot;, # Optional. The display name of the session.
      &quot;name&quot;: &quot;A String&quot;, # Required. Identifier. The resource name of the session. Format: &#x27;projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}&#x27;.
      &quot;sessionState&quot;: { # Optional. Session specific memory which stores key conversation points.
        &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
      },
      &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the session was updated.
      &quot;userId&quot;: &quot;A String&quot;, # Required. Immutable. String id provided by the user
    },
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next()</code>
  <pre>Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call &#x27;execute()&#x27; on to request the next
          page. Returns None if there are no more items in the collection.
        </pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
  <pre>Updates the specific Session.

Args:
  name: string, Required. Identifier. The resource name of the session. Format: &#x27;projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}&#x27;. (required)
  body: object, The request body.
    The object takes the form of:

{ # A session contains a set of actions between users and Vertex agents.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the session was created.
  &quot;displayName&quot;: &quot;A String&quot;, # Optional. The display name of the session.
  &quot;name&quot;: &quot;A String&quot;, # Required. Identifier. The resource name of the session. Format: &#x27;projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}&#x27;.
  &quot;sessionState&quot;: { # Optional. Session specific memory which stores key conversation points.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
  },
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the session was updated.
  &quot;userId&quot;: &quot;A String&quot;, # Required. Immutable. String id provided by the user
}

  updateMask: string, Optional. Field mask is used to control which fields get updated. If the mask is not present, all fields will be updated.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A session contains a set of actions between users and Vertex agents.
  &quot;createTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the session was created.
  &quot;displayName&quot;: &quot;A String&quot;, # Optional. The display name of the session.
  &quot;name&quot;: &quot;A String&quot;, # Required. Identifier. The resource name of the session. Format: &#x27;projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}&#x27;.
  &quot;sessionState&quot;: { # Optional. Session specific memory which stores key conversation points.
    &quot;a_key&quot;: &quot;&quot;, # Properties of the object.
  },
  &quot;updateTime&quot;: &quot;A String&quot;, # Output only. Timestamp when the session was updated.
  &quot;userId&quot;: &quot;A String&quot;, # Required. Immutable. String id provided by the user
}</pre>
</div>

</body></html>